﻿// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ISupportDelete.cs" company="Tuckerman Software">
// Copyright 2012 Tuckerman Software, New Hampshire, USA
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace Circles.Persistence
{
    using System;

    using Circles.Domain;

    /// <summary>
    /// A "role" interface that allows repositories to be
    /// marked as supporting deletions.
    /// </summary>
    /// <typeparam name="T">A type derived from Entity</typeparam>
    /// <typeparam name="TId">The type of the unique identity for the Entity</typeparam>
    public interface ISupportDelete<T, in TId> where T : Entity
    {
        /// <summary>
        /// Deletes an entity instance from the repository.
        /// </summary>
        /// <typeparam name="TId">The <see cref="Type"/> used to define the Entity's unique id.</typeparam>
        /// <param name="id">Unique identifier for an entity.</param>
        void Delete(TId id);
    }
}
